/*
* Most of this source has been derived from the Linux USB
* project:
* (C) Copyright Linus Torvalds 1999
* (C) Copyright Johannes Erdfelt 1999-2001
* (C) Copyright Andreas Gal 1999
* (C) Copyright Gregory P. Smith 1999
* (C) Copyright Deti Fliegl 1999 (new USB architecture)
* (C) Copyright Randy Dunlap 2000
* (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
* (C) Copyright Yggdrasil Computing, Inc. 2000
*     (usb_device_id matching changes by Adam J. Richter)
*
* Adapted for U-Boot:
* (C) Copyright 2001 Denis Peter, MPL AG Switzerland
*
* SPDX-License-Identifier:	GPL-2.0+
*/

/****************************************************************************
* HUB "Driver"
* Probes device for being a hub and configurate it
*/

#include <StdAfx.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>
#include <errno.h>

DECLARE_GLOBAL_DATA_PTR;

#include "hxadapt.h"
#include "usb_defs.h"
#include "usbdescriptors.h"
#include "ch9.h"
#include "usb.h"

#ifdef CONFIG_4xx
#include <asm/4xx_pci.h>
#endif

#ifndef USB_BUFSIZ
#define USB_BUFSIZ	512
#endif

/* TODO(sjg@chromium.org): Remove this when CONFIG_DM_USB is defined */
static struct usb_hub_device hub_dev[USB_MAX_HUB];
static int usb_hub_index;

#ifdef __MS_VC__
void usb_hub_reset_devices(int port)
#else
__weak void usb_hub_reset_devices(int port)
#endif
{
	return;
}

static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
{
	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
		USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
		USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
}

static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
{
	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
		USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
		port, NULL, 0, USB_CNTL_TIMEOUT);
}

static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
{
	return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
		USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
		port, NULL, 0, USB_CNTL_TIMEOUT);
}

static int usb_get_hub_status(struct usb_device *dev, void *data)
{
	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
		USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
		data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
}

int usb_get_port_status(struct usb_device *dev, int port, void *data)
{
	return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
		USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
		data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
}


static void usb_hub_power_on(struct usb_hub_device *hub)
{
	int i;
	struct usb_device *dev;
	unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
#ifdef __GCC__
	const char *env;
#endif

	dev = hub->pusb_dev;

	debug("enabling power on all ports\r\n");
	for (i = 0; i < dev->maxchild; i++) {
		usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
		debug("port %d returns %lX\r\n", i + 1, dev->status);
	}

	/*
	* Wait for power to become stable,
	* plus spec-defined max time for device to connect
	* but allow this time to be increased via env variable as some
	* devices break the spec and require longer warm-up times
	*/
#ifdef __GCC__
	env = getenv("usb_pgood_delay");
	if (env)
		pgood_delay = max(pgood_delay,
		(unsigned)simple_strtol(env, NULL, 0));
#endif
	debug("pgood_delay=%dms\r\n", pgood_delay);
	mdelay(pgood_delay + 200);
}

void usb_hub_reset(void)
{
	usb_hub_index = 0;
}

static struct usb_hub_device *usb_hub_allocate(void)
{
	if (usb_hub_index < USB_MAX_HUB)
		return &hub_dev[usb_hub_index++];

	printf("ERROR: USB_MAX_HUB (%d) reached\r\n", USB_MAX_HUB);
	return NULL;
}

#define MAX_TRIES 5

static inline char *portspeed(int portstatus)
{
	char *speed_str;

	switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
	case USB_PORT_STAT_SUPER_SPEED:
		speed_str = "5 Gb/s";
		break;
	case USB_PORT_STAT_HIGH_SPEED:
		speed_str = "480 Mb/s";
		break;
	case USB_PORT_STAT_LOW_SPEED:
		speed_str = "1.5 Mb/s";
		break;
	default:
		speed_str = "12 Mb/s";
		break;
	}

	return speed_str;
}

int legacy_hub_port_reset(struct usb_device *dev, int port,
	unsigned short *portstat)
{
	int err, tries;
	ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
	unsigned short portstatus, portchange;

#ifdef CONFIG_DM_USB
	debug("%s: resetting '%s' port %d...\r\n", __func__, dev->dev->name,
		port + 1);
#else
	debug("%s: resetting port %d...\r\n", __func__, port + 1);
#endif
	for (tries = 0; tries < MAX_TRIES; tries++) {
		err = usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
		if (err < 0)
		{
			debug("%s: usb_set_port_feature [%d] failed with err = %d.\r\n", __func__,port, err);
			return err;
		}
		debug("%s: usb_set_port_feature [%d] success.\r\n", __func__, port);

		mdelay(50);

		if (usb_get_port_status(dev, port + 1, portsts) < 0) {
			debug("get_port_status failed status %lX\r\n",
				dev->status);
			return -1;
		}
		portstatus = le16_to_cpu(portsts->wPortStatus);
		portchange = le16_to_cpu(portsts->wPortChange);

		debug("portstatus %x, change %x, %s\r\n", portstatus, portchange,
			portspeed(portstatus));

		debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
			"  USB_PORT_STAT_ENABLE %d\r\n",
			(portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
			(portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
			(portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);

		/*
		* Perhaps we should check for the following here:
		* - C_CONNECTION hasn't been set.
		* - CONNECTION is still set.
		*
		* Doing so would ensure that the device is still connected
		* to the bus, and hasn't been unplugged or replaced while the
		* USB bus reset was going on.
		*
		* However, if we do that, then (at least) a San Disk Ultra
		* USB 3.0 16GB device fails to reset on (at least) an NVIDIA
		* Tegra Jetson TK1 board. For some reason, the device appears
		* to briefly drop off the bus when this second bus reset is
		* executed, yet if we retry this loop, it'll eventually come
		* back after another reset or two.
		*/

		if (portstatus & USB_PORT_STAT_ENABLE)
			break;

		//mdelay(200);
	}

	if (tries == MAX_TRIES) {
		debug("Cannot enable port %i after %i retries, " \
			"disabling port.\r\n", port + 1, MAX_TRIES);
		debug("Maybe the USB cable is bad?\r\n");
		return -1;
	}

	usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
	*portstat = portstatus;
	return 0;
}

#ifdef CONFIG_DM_USB
int hub_port_reset(struct udevice *dev, int port, unsigned short *portstat)
{
	struct usb_device *udev = dev_get_parentdata(dev);

	return legacy_hub_port_reset(udev, port, portstat);
}
#endif

int usb_hub_port_connect_change(struct usb_device *dev, int port)
{
	ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
	unsigned short portstatus;
	int ret, speed;
	struct usb_device *usb;

	/* Check status */
	ret = usb_get_port_status(dev, port + 1, portsts);
	if (ret < 0) {
		debug("get_port_status failed\r\n");
		return ret;
	}

	portstatus = le16_to_cpu(portsts->wPortStatus);
	debug("portstatus %x, change %x, %s\r\n",
		portstatus,
		le16_to_cpu(portsts->wPortChange),
		portspeed(portstatus));

	/* Clear the connection change status */
	usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);

	/* Disconnect any existing devices under this port */
	if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
		(!(portstatus & USB_PORT_STAT_ENABLE))) ||
		usb_device_has_child_on_port(dev, port)) {
		debug("usb_disconnect(&hub->children[port]);\r\n");
		/* Return now if nothing is connected */
		if (!(portstatus & USB_PORT_STAT_CONNECTION))
			return -ENOTCONN;
	}
	mdelay(50);

	/* Reset the port */
	ret = legacy_hub_port_reset(dev, port, &portstatus);
	if (ret < 0) {
		if (ret != -ENXIO)
			printf("cannot reset port %i!?\r\n", port + 1);
		return ret;
	}

	mdelay(50);

	switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
	case USB_PORT_STAT_SUPER_SPEED:
		speed = USB_SPEED_SUPER;
		break;
	case USB_PORT_STAT_HIGH_SPEED:
		speed = USB_SPEED_HIGH;
		break;
	case USB_PORT_STAT_LOW_SPEED:
		speed = USB_SPEED_LOW;
		break;
	default:
		speed = USB_SPEED_FULL;
		break;
	}

#ifdef CONFIG_DM_USB
	struct udevice *child;

	ret = usb_scan_device(dev->dev, port + 1, speed, &child);
#else
	//struct usb_device *usb;

	ret = usb_alloc_new_device(dev->controller, &usb);
	if (ret) {
		printf("cannot create new device: ret=%d", ret);
		return ret;
	}

	dev->children[port] = usb;
	usb->speed = speed;
	usb->parent = dev;
	usb->portnr = port + 1;
	/* Run it through the hoops (find a driver, etc) */
	ret = usb_new_device(usb);
	if (ret < 0) {
		/* Woops, disable the port */
		usb_free_device(dev->controller);
		dev->children[port] = NULL;
	}
#endif
	if (ret < 0) {
		debug("hub: disabling port %d\r\n", port + 1);
		usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
	}

	return ret;
}


static int usb_hub_configure(struct usb_device *dev)
{
	int i, length;
	ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
	unsigned char *bitmap;
	short hubCharacteristics;
	struct usb_hub_descriptor *descriptor;
	struct usb_hub_device *hub;
#ifdef __MS_VC__  //Can not support __maybe_unused key word.
	struct usb_hub_status* hubsts;
#else
	__maybe_unused struct usb_hub_status *hubsts;
#endif
	int ret;

	/* "allocate" Hub device */
	hub = usb_hub_allocate();
	if (hub == NULL)
		return -ENOMEM;
	hub->pusb_dev = dev;
	/* Get the the hub descriptor */
	ret = usb_get_hub_descriptor(dev, buffer, 4);
	if (ret < 0) {
		debug("usb_hub_configure: failed to get hub " \
			"descriptor, giving up %lX\r\n", dev->status);
		return ret;
	}
	descriptor = (struct usb_hub_descriptor *)buffer;

#ifdef __MS_VC__ //Can not support typeof operation.
	length = min(descriptor->bLength, sizeof(struct usb_hub_descriptor));
#else
	length = min_t(int, descriptor->bLength,
		sizeof(struct usb_hub_descriptor));
#endif

	ret = usb_get_hub_descriptor(dev, buffer, length);
	if (ret < 0) {
		debug("usb_hub_configure: failed to get hub " \
			"descriptor 2nd giving up %lX\r\n", dev->status);
		return ret;
	}
	memcpy((unsigned char *)&hub->desc, buffer, length);
	/* adjust 16bit values */
	put_unaligned(le16_to_cpu(get_unaligned(
		&descriptor->wHubCharacteristics)),
		&hub->desc.wHubCharacteristics);
	/* set the bitmap */
	bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
	/* devices not removable by default */
	memset(bitmap, 0xff, (USB_MAXCHILDREN + 1 + 7) / 8);
	bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
	memset(bitmap, 0xff, (USB_MAXCHILDREN + 1 + 7) / 8); /* PowerMask = 1B */

	for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7) / 8); i++)
		hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];

	for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7) / 8); i++)
		hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];

	dev->maxchild = descriptor->bNbrPorts;
	debug("%d ports detected\r\n", dev->maxchild);

	hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
	switch (hubCharacteristics & HUB_CHAR_LPSM) {
	case 0x00:
		debug("ganged power switching\r\n");
		break;
	case 0x01:
		debug("individual port power switching\r\n");
		break;
	case 0x02:
	case 0x03:
		debug("unknown reserved power switching mode\r\n");
		break;
	}

	if (hubCharacteristics & HUB_CHAR_COMPOUND)
		debug("part of a compound device\r\n");
	else
		debug("standalone hub\r\n");

	switch (hubCharacteristics & HUB_CHAR_OCPM) {
	case 0x00:
		debug("global over-current protection\r\n");
		break;
	case 0x08:
		debug("individual port over-current protection\r\n");
		break;
	case 0x10:
	case 0x18:
		debug("no over-current protection\r\n");
		break;
	}

	debug("power on to power good time: %dms\r\n",
		descriptor->bPwrOn2PwrGood * 2);
	debug("hub controller current requirement: %dmA\r\n",
		descriptor->bHubContrCurrent);

	for (i = 0; i < dev->maxchild; i++)
		debug("port %d is%s removable\r\n", i + 1,
		hub->desc.DeviceRemovable[(i + 1) / 8] & \
		(1 << ((i + 1) % 8)) ? " not" : "");

	if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
		debug("usb_hub_configure: failed to get Status - " \
			"too long: %d\r\n", descriptor->bLength);
		return -EFBIG;
	}

	ret = usb_get_hub_status(dev, buffer);
	if (ret < 0) {
		debug("usb_hub_configure: failed to get Status %lX\r\n",
			dev->status);
		return ret;
	}

#ifdef DEBUG
	hubsts = (struct usb_hub_status *)buffer;
#endif

	debug("get_hub_status returned status %X, change %X\r\n",
		le16_to_cpu(hubsts->wHubStatus),
		le16_to_cpu(hubsts->wHubChange));
	debug("local power source is %s\r\n",
		(le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
		"lost (inactive)" : "good");
	debug("%sover-current condition exists\r\n",
		(le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
		"" : "no ");
	usb_hub_power_on(hub);

	/*
	* Reset any devices that may be in a bad state when applying
	* the power.  This is a __weak function.  Resetting of the devices
	* should occur in the board file of the device.
	*/
	for (i = 0; i < dev->maxchild; i++)
		usb_hub_reset_devices(i + 1);

	for (i = 0; i < dev->maxchild; i++) {
		ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
		unsigned short portstatus, portchange;
		int ret;
		ulong start = 10; //CONFIG_SYS_HZ;

		debug("%s: scanning port %d...\r\n",__func__,i + 1);
		//Reset the port first.
		legacy_hub_port_reset(dev, i, &portstatus);

		/*
		* Wait for (whichever finishes first)
		*  - A maximum of 10 seconds
		*    This is a purely observational value driven by connecting
		*    a few broken pen drives and taking the max * 1.5 approach
		*  - connection_change and connection state to report same
		*    state
		*/
		do {
			ret = usb_get_port_status(dev, i + 1, portsts);
			if (ret < 0) {
				debug("get_port_status failed\r\n");
				break;
			}

			portstatus = le16_to_cpu(portsts->wPortStatus);
			portchange = le16_to_cpu(portsts->wPortChange);

			/* No connection change happened, wait a bit more. */
			if (!(portchange & USB_PORT_STAT_C_CONNECTION))
				continue;

			/* Test if the connection came up, and if so, exit. */
			if (portstatus & USB_PORT_STAT_CONNECTION)
				break;
			//Wait for a short time to let USB port stable...
		} while ((mdelay(5),/*printf("."),*/ start --));
		//while (get_timer(start) < CONFIG_SYS_HZ * 1);

		if (ret < 0)
			continue;

		debug("Port %d Status %X Change %X\r\n",i + 1, portstatus, portchange);

		//Original code from uboot only has the first if condition of the following code,
		//but in some case,especial the EHCI controller managing a rate matching hub,
		//the portchange may not change,but portstatus reflects that port is enabled and
		//has connection.So we add the second if condition,treat it also as the port change
		//event.
		if ((portchange & USB_PORT_STAT_C_CONNECTION) || ((portstatus & USB_PORT_STAT_ENABLE) && (portstatus & USB_PORT_STAT_CONNECTION)))
		{
			debug("port %d connection change\r\n", i + 1);
			_hx_printf("USB: Find a device on port [%d] of USB HUB [%d].\r\n",
				i,
				dev->devnum);
			usb_hub_port_connect_change(dev, i);
		}

		if (portchange & USB_PORT_STAT_C_ENABLE) {
			debug("port %d enable change, status %x\r\n",
				i + 1, portstatus);
			usb_clear_port_feature(dev, i + 1,
				USB_PORT_FEAT_C_ENABLE);
			/*
			* The following hack causes a ghost device problem
			* to Faraday EHCI
			*/
#ifndef CONFIG_USB_EHCI_FARADAY
			/* EM interference sometimes causes bad shielded USB
			* devices to be shutdown by the hub, this hack enables
			* them again. Works at least with mouse driver */
			if (!(portstatus & USB_PORT_STAT_ENABLE) &&
				(portstatus & USB_PORT_STAT_CONNECTION) &&
				usb_device_has_child_on_port(dev, i)) {
				debug("already running port %i "  \
					"disabled by hub (EMI?), " \
					"re-enabling...\r\n", i + 1);
				usb_hub_port_connect_change(dev, i);
			}
#endif
		}
		if (portstatus & USB_PORT_STAT_SUSPEND) {
			debug("port %d suspend change\r\n", i + 1);
			usb_clear_port_feature(dev, i + 1,
				USB_PORT_FEAT_SUSPEND);
		}

		if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
			debug("port %d over-current change\r\n", i + 1);
			usb_clear_port_feature(dev, i + 1,
				USB_PORT_FEAT_C_OVER_CURRENT);
			usb_hub_power_on(hub);
		}

		if (portchange & USB_PORT_STAT_C_RESET) {
			debug("port %d reset change\r\n", i + 1);
			usb_clear_port_feature(dev, i + 1,
				USB_PORT_FEAT_C_RESET);
		}
	} /* end for i all ports */
	return 0;
}

static int usb_hub_check(struct usb_device *dev, int ifnum)
{
	struct usb_interface *iface;
	struct usb_endpoint_descriptor *ep = NULL;

	iface = &dev->config.if_desc[ifnum];
	/* Is it a hub? */
	if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
		goto err;
	/* Some hubs have a subclass of 1, which AFAICT according to the */
	/*  specs is not defined, but it works */
	if ((iface->desc.bInterfaceSubClass != 0) &&
		(iface->desc.bInterfaceSubClass != 1))
		goto err;
	/* Multiple endpoints? What kind of mutant ninja-hub is this? */
	if (iface->desc.bNumEndpoints != 1)
		goto err;
	ep = &iface->ep_desc[0];
	/* Output endpoint? Curiousier and curiousier.. */
	if (!(ep->bEndpointAddress & USB_DIR_IN))
		goto err;
	/* If it's not an interrupt endpoint, we'd better punt! */
	if ((ep->bmAttributes & 3) != 3)
		goto err;
	/* We found a hub */
	debug("USB hub found\r\n");
	return 0;

err:
	debug("USB hub not found: bInterfaceClass=%d, bInterfaceSubClass=%d, bNumEndpoints=%d\r\n",
		iface->desc.bInterfaceClass, iface->desc.bInterfaceSubClass,
		iface->desc.bNumEndpoints);
	if (ep) {
		debug("   bEndpointAddress=%#x, bmAttributes=%d",
			ep->bEndpointAddress, ep->bmAttributes);
	}

	return -ENOENT;
}

int usb_hub_probe(struct usb_device *dev, int ifnum)
{
	int ret;

	ret = usb_hub_check(dev, ifnum);
	if (ret)
	{
		debug("usb_hub_probe return with value = %d.\r\n", ret);
		return 0;
	}
	ret = usb_hub_configure(dev);
	return ret;
}

#ifdef CONFIG_DM_USB
int usb_hub_scan(struct udevice *hub)
{
	struct usb_device *udev = dev_get_parentdata(hub);

	return usb_hub_configure(udev);
}

static int usb_hub_post_bind(struct udevice *dev)
{
	/* Scan the bus for devices */
	return dm_scan_fdt_node(dev, gd->fdt_blob, dev->of_offset, false);
}

static int usb_hub_post_probe(struct udevice *dev)
{
	debug("%s\r\n", __func__);
	return usb_hub_scan(dev);
}

static const struct udevice_id usb_hub_ids[] = {
	{ .compatible = "usb-hub" },
	{}
};

U_BOOT_DRIVER(usb_generic_hub) = {
	.name = "usb_hub",
	.id = UCLASS_USB_HUB,
	.of_match = usb_hub_ids,
	.flags = DM_FLAG_ALLOC_PRIV_DMA,
};

UCLASS_DRIVER(usb_hub) = {
	.id = UCLASS_USB_HUB,
	.name = "usb_hub",
	.post_bind = usb_hub_post_bind,
	.post_probe = usb_hub_post_probe,
	.child_pre_probe = usb_child_pre_probe,
	.per_child_auto_alloc_size = sizeof(struct usb_device),
	.per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
};

static const struct usb_device_id hub_id_table[] = {
	{
		.match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
		.bDeviceClass = USB_CLASS_HUB
	},
	{}	/* Terminating entry */
};

U_BOOT_USB_DEVICE(usb_generic_hub, hub_id_table);

#endif
